home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / bbs / jfrq103.zip / JFREQ.DOC < prev    next >
Text File  |  1996-06-22  |  42KB  |  1,036 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                    - - - - -
  8.                                    J F R e q
  9.                                    - - - - -
  10.  
  11.  
  12.            External File Request Processor for FrontDoor, MainDoor,
  13.        Intermail or compatible mailers & Remote Access, Maximus, or any
  14.                    BBS system based on a FILES.BBS structure
  15.  
  16.  
  17.                   (C) 1994-96 Jordi Sese (Fidonet 2:343/116)
  18.  
  19.  
  20.                                  version 1.03
  21.  
  22.  
  23.  
  24.  
  25.                                    IMPORTANT
  26.      This program IS NOT, public domain. It is a Shareware Product. Please
  27.       read the document REGISTER.TXT to know about its conditions of use
  28.  
  29.  
  30.  
  31.  
  32.  
  33.                                Table of Contents
  34.  
  35.  
  36.  
  37.   1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  38.     1.1 What is a File Request Processor? . . . . . . . . . . . . . . . . . 1
  39.     1.2 Features of JFReq 1.03  . . . . . . . . . . . . . . . . . . . . . . 1
  40.     1.3 Files in the distribution package . . . . . . . . . . . . . . . . . 2
  41.  
  42.   2. Setup  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  43.     2.1 UPGRADING from version 1.00 . . . . . . . . . . . . . . . . . . . . 3
  44.     2.2 UPGRADING from version 1.01 . . . . . . . . . . . . . . . . . . . . 3
  45.     2.3 UPGRADING from version 1.02 . . . . . . . . . . . . . . . . . . . . 3
  46.     2.4 General Installation Notes  . . . . . . . . . . . . . . . . . . . . 3
  47.     2.5 Multiline systems . . . . . . . . . . . . . . . . . . . . . . . . . 4
  48.     2.6 Environment Variables . . . . . . . . . . . . . . . . . . . . . . . 4
  49.     2.7 Mailer Setup  . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
  50.       2.7.1 MainDoor & MainDoor/2 . . . . . . . . . . . . . . . . . . . . . 5
  51.       2.7.2 FrontDoor 2.1x & 2.2x . . . . . . . . . . . . . . . . . . . . . 5
  52.       2.7.3 Intermail 2.27  . . . . . . . . . . . . . . . . . . . . . . . . 5
  53.       2.7.4 T-Mail mailer . . . . . . . . . . . . . . . . . . . . . . . . . 6
  54.       2.7.5 SRIF capable mailer . . . . . . . . . . . . . . . . . . . . . . 6
  55.     2.8 The Setup Program (JFREQCFG.COM / JFRQCFGP.EXE) . . . . . . . . . . 6
  56.       2.8.1 Global Options  . . . . . . . . . . . . . . . . . . . . . . . . 6
  57.       2.8.2 Time Settings:  . . . . . . . . . . . . . . . . . . . . . . . . 7
  58.       2.8.3 Limits  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
  59.       2.8.4 Mail Addresses  . . . . . . . . . . . . . . . . . . . . . . . . 8
  60.       2.8.5 Template Editor . . . . . . . . . . . . . . . . . . . . . . . . 8
  61.  
  62.   3. Other data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
  63.     3.1 JFReq Command Line Parameters . . . . . . . . . . . . . . . . . . . 9
  64.     3.2 Tokens used in templates  . . . . . . . . . . . . . . . . . . . . . 9
  65.     3.3 File Format for File & Directory listings and Alias file  . . . .  11
  66.       3.3.1 file & directory listing: . . . . . . . . . . . . . . . . . .  11
  67.       3.3.2 ALIAS listing:  . . . . . . . . . . . . . . . . . . . . . . .  11
  68.       3.3.3 On-line Programs and the alias file list  . . . . . . . . . .  11
  69.     3.4 The nodelist compiler . . . . . . . . . . . . . . . . . . . . . .  12
  70.     3.5 The custom file index compiler  . . . . . . . . . . . . . . . . .  13
  71.     3.6 Remote Access file index Speed-up . . . . . . . . . . . . . . . .  13
  72.     3.7 VIP Systems . . . . . . . . . . . . . . . . . . . . . . . . . . .  13
  73.     3.8 Statistical Reports . . . . . . . . . . . . . . . . . . . . . . .  14
  74.     3.9 Special Requests with Attached Messages . . . . . . . . . . . . .  15
  75.     3.10 TIC support  . . . . . . . . . . . . . . . . . . . . . . . . . .  15
  76.     3.11 Editor Commands  . . . . . . . . . . . . . . . . . . . . . . . .  15
  77.     3.12 Local Testing  . . . . . . . . . . . . . . . . . . . . . . . . .  16
  78.     3.13 Credits  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  16
  79.     3.14 How to contact the author  . . . . . . . . . . . . . . . . . . .  17
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.                                        i
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.                                    Chapter 1
  94.  
  95.                                  Introduction
  96.  
  97.  
  98.  
  99.  
  100.  
  101.   1.1 What is a File Request Processor?
  102.  
  103.   Once upon a time, fidonet mailers searched a huge list of directories  each
  104.   time  another  system requested a file, wasting a lot of time in sequential
  105.   searches.  Now, from  FrontDoor  2.1x,  Intermail  2.27  and  MainDoor  and
  106.   MainDoor/2,  you  can  execute  an  external  utility  to fast locate those
  107.   requested files and  generate  a  personalised  response  message  for  the
  108.   asking system.
  109.  
  110.   JFReq  uses  the existing file indexes of the BBS package (Maximus & Remote
  111.   Access are currently supported).  This use of the automated index  of  your
  112.   BBS  makes  it  possible  to run this program with almost no maintenance at
  113.   all.
  114.  
  115.  
  116.   1.2 Features of JFReq 1.03
  117.  
  118.   * Native versions for DOS and OS/2
  119.   * Multiline support
  120.   * Easy to use configuration program
  121.   * Mailers supported:   FrontDoor (2.1x or better), MainDoor, InterMail
  122.     (2.27 or better), T-Mail or compatible mailers. Also supports SRIF
  123.   * BBS File Bases supported:  Maximus (2.x, 3.x) and Remote Access (2.x)
  124.     (supported directly), and any system based on the FILES.BBS
  125.     structure.
  126.   * Directory listing and Alias file (with or without password)
  127.   * You can limit by day and/or session: Files, Kbytes to transmit, and
  128.     session lenght in minutes.
  129.   * Five types of session: Secure(with password), Listed & Unlisted
  130.     Systems, VIP Systems (fully customizable) and a Happy Hour period,
  131.     defining file lists and limits for each type of session separately.
  132.   * You can search for the existence of a specific node in a custom
  133.     nodelist index.
  134.   * Use of an equivalent user level for BBS File Base access
  135.   * Twit systems control definition, checking every piece of information
  136.     from the remote system
  137.   * Request Report and error messages are totally customizable, and
  138.     templates are selected automatically depending on the remote system's
  139.     address
  140.   * Additional messages are added when the remote system requests a
  141.     special file
  142.   * JFReq can send TIC files describing each of the files
  143.  
  144.  
  145.                                        1
  146.  
  147.   Chapter 1. Introduction                                                   2
  148.  
  149.  
  150.   * On-line program execution for registrations or remote processes
  151.   * File Password & Download Counter Support in Remote Access
  152.   * Automatic Download Counter Support for Maximus and FILES.BBS index.
  153.   * Free file/area support in all modes
  154.   * File Buffering for CD-ROMs and other critical drives
  155.   * Statistical reports as messages.
  156.  
  157.  
  158.   1.3 Files in the distribution package
  159.  
  160.   100to101.COM    Configuration upgrade program to 1.01
  161.   101to102.COM    Configuration upgrade program to 1.02
  162.   102to103.COM    Configuration upgrade program to 1.03
  163.   STCONV.COM      Statistics upgrade program from 1.00 & 1.01. DOS version
  164.   STCONVP.EXE     Statistics upgrade program from 1.00 & 1.01. OS/2 version
  165.   JFREQ.DOC       JFReq users' manual. English version
  166.   JFREQ.ESP       JFReq users' manual. Spanish version
  167.   JFREQP.EXE      JFReq main executable. OS/2 version
  168.   JFRQCFGP.EXE    JFReq configuration utility. OS/2
  169.   JFREQ.EXE       JFReq main executable. DOS version
  170.   JFREQCFG.COM    JFReq configuration utility. DOS
  171.   JFNCP.EXE       Nodelist compiler. OS/2 version
  172.   JFNC.COM        Nodelist compiler. DOS version
  173.   JFNC.CTL        Nodelist control file for JFNC
  174.   JFFCP.EXE       Secondary file index generator. OS/2
  175.   JFFC.COM        Secondary file index generator. DOS
  176.   JFFC.CTL        Secondary file index control file
  177.   JFSTATP.EXE     Statistical Reports generator. OS/2
  178.   JFSTAT.COM      Statistical Reports generator. DOS
  179.   LDATP.EXE       JFREQ.DAT lister (OS/2)
  180.   LDAT.COM        JFREQ.DAT lister (DOS)
  181.   DEFAULT.FRQ     Default response template
  182.   *.FRQ           Sample response templates
  183.   FNAMES.DAT      Special requests control file
  184.   REGISTER.TXT    Registration info, English version
  185.   REGISTRO.TXT    Registration info, Spanish version
  186.   UADDRESS.DAT    Twit